#
# $Id: utest.pl,v 1.13 2012/03/02 16:21:40 yaronm Exp $
# Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
# Broadcom Limited and/or its subsidiaries.
# 
# Broadcom Switch Software License
# 
# This license governs the use of the accompanying Broadcom software. Your 
# use of the software indicates your acceptance of the terms and conditions 
# of this license. If you do not agree to the terms and conditions of this 
# license, do not use the software.
# 1. Definitions
#    "Licensor" means any person or entity that distributes its Work.
#    "Software" means the original work of authorship made available under 
#    this license.
#    "Work" means the Software and any additions to or derivative works of 
#    the Software that are made available under this license.
#    The terms "reproduce," "reproduction," "derivative works," and 
#    "distribution" have the meaning as provided under U.S. copyright law.
#    Works, including the Software, are "made available" under this license 
#    by including in or with the Work either (a) a copyright notice 
#    referencing the applicability of this license to the Work, or (b) a copy 
#    of this license.
# 2. Grant of Copyright License
#    Subject to the terms and conditions of this license, each Licensor 
#    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
#    copyright license to reproduce, prepare derivative works of, publicly 
#    display, publicly perform, sublicense and distribute its Work and any 
#    resulting derivative works in any form.
# 3. Grant of Patent License
#    Subject to the terms and conditions of this license, each Licensor 
#    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
#    patent license to make, have made, use, offer to sell, sell, import, and 
#    otherwise transfer its Work, in whole or in part. This patent license 
#    applies only to the patent claims licensable by Licensor that would be 
#    infringed by Licensor's Work (or portion thereof) individually and 
#    excluding any combinations with any other materials or technology.
#    If you institute patent litigation against any Licensor (including a 
#    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
#    you allege are infringed by any Work, then your patent license from such 
#    Licensor to the Work shall terminate as of the date such litigation is 
#    filed.
# 4. Redistribution
#    You may reproduce or distribute the Work only if (a) you do so under 
#    this License, (b) you include a complete copy of this License with your 
#    distribution, and (c) you retain without modification any copyright, 
#    patent, trademark, or attribution notices that are present in the Work.
# 5. Derivative Works
#    You may specify that additional or different terms apply to the use, 
#    reproduction, and distribution of your derivative works of the Work 
#    ("Your Terms") only if (a) Your Terms provide that the limitations of 
#    Section 7 apply to your derivative works, and (b) you identify the 
#    specific derivative works that are subject to Your Terms. 
#    Notwithstanding Your Terms, this license (including the redistribution 
#    requirements in Section 4) will continue to apply to the Work itself.
# 6. Trademarks
#    This license does not grant any rights to use any Licensor's or its 
#    affiliates' names, logos, or trademarks, except as necessary to 
#    reproduce the notices described in this license.
# 7. Limitations
#    Platform. The Work and any derivative works thereof may only be used, or 
#    intended for use, with a Broadcom switch integrated circuit.
#    No Reverse Engineering. You will not use the Work to disassemble, 
#    reverse engineer, decompile, or attempt to ascertain the underlying 
#    technology of a Broadcom switch integrated circuit.
# 8. Termination
#    If you violate any term of this license, then your rights under this 
#    license (including the license grants of Sections 2 and 3) will 
#    terminate immediately.
# 9. Disclaimer of Warranty
#    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
#    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
#    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
#    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
#    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
#    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
# 10. Limitation of Liability
#    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
#    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
#    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
#    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
#    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
#    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
#    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
#    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
#    THE POSSIBILITY OF SUCH DAMAGES.
# 
# 
#
# File:        utest.pl
# Purpose:     Unit test script for the CINT library
#
#

use IPC::Open2;


my $tdata = shift;
my $tname = shift;

if(!defined($tdata)) {
  $tdata = "utests";
}

open TDATA, "$tdata" || die("Could not open file '$tdata'");
open LOG, ">results.$tdata" || die("Could not open log file");

my @tdata = <TDATA>;
my $tdata = join "", @tdata;

my @tests;

#
# Remove all comments
#
while ($tdata =~ s/#(.*?)\n//g) {};

#
# convert %include to #include
#
while ($tdata =~ s/%include/#include/g) {};

#
# Read all begin/end code blocks
#
my @startcode;
my @endcode;

while($tdata =~ s/STARTCODE\n(.*?)\nENDCODE\n(.*?)\nEND//s) {
  push @startcode, $1;
  push @endcode, $2;
}

#
# Read all named tests cases
#
while ($tdata =~ s/TEST (.*?)\nCODE\n(.*?)\nRESULT\n(.*?)\nEND//s) {
  my $r = {};
  $r->{NAME} = $1;
  $r->{CODE} = $2;
  $r->{RESULT} = $3;
  push @tests, $r;
}

#
# Read all unnamed/new test cases.
#
my $tnum = $#tests+1;
while ($tdata =~ s/CODE\n(.*?)RESULT\n(.*?)END//s) {
  my $r = {};
  $r->{NAME} = "$tnum"; $tnum++;
  $r->{CODE} = $1;
  $r->{RESULT} = $2;
  push @tests, $r;
}

if($tdata !~ /^\s*$/) {
  die("Excess data left after reading testcases: '$tdata'");
}

#
# Execute tests
#
my $pcount = 0;
my $fcount = 0;

if(defined($tname)) {
  run_test($tests[$tname]);
}
else {
  foreach my $test (@tests)
    {
      run_test($test);
    }
}

print "\n$pcount passed, $fcount failed\n\n";
print LOG "$pcount passed, $fcount failed\n";
close LOG;


### SUBROUTINES ##################################################

sub run_test
  {
    my $test = shift;

    printf("$test->{NAME}: ");

    my($rfh, $wfh);
    #my $pid = open2($rfh, $wfh, "valgrind --leak-check=full ./cint --noprompt");
    #my $pid = open2($rfh, $wfh, "valgrind --leak-check=full --track-fds=yes ./cint --noprompt");
    my $pid = open2($rfh, $wfh, "./cint --noprompt");

    print $wfh @startcode;
    print $wfh $test->{CODE};
    print $wfh @endcode;
    close $wfh;

    my @results = <$rfh>;
    my $results = join "", @results;

    if($results eq $test->{RESULT}) {
      $pcount++;
      print "PASS\n";
    }
    else {
      $fcount++;
      # Check for test comment at beginning of test
      my $comment;
      if($test->{CODE} =~ /^\"(.*?)\"/) {
        $comment = $1;
      }
      print "FAIL      $comment\n";
      print LOG "TEST $test->{NAME} FAILED\n";
      print LOG "CODE\n";
      print LOG $test->{CODE};
      print LOG "RESULT\n";
      print LOG $test->{RESULT};
      print LOG "ACTUAL\n";
      print LOG "$results\n\n";
      print LOG "END\n";

      open F, ">$test->{NAME}.expected";

      print F "START CODE:\n";
      print F "$test->{CODE};\n";
      print F "END CODE:\n\n";

      print F "$test->{RESULT}\n";
      close F;
      open F, ">$test->{NAME}.actual";
      print F "START CODE:\n";
      print F "$test->{CODE};\n";
      print F "END CODE:\n\n";
      print F "$results\n";
      close F;
      open F, ">$test->{NAME}.code";
      print F @startcode;
      print F $test->{CODE};
      print F @endcode;
      if(defined($ENV{FD})) {
        system("tkdiff $test->{NAME}.expected $test->{NAME}.actual &");
      }
      close F;
    }
  }



